<include target="_header.html" />

<div id="vi-content">
	<!-- Index -->
	<ol class="toc">
      <li style="margin-bottom: 0.3em;"><a href="#Overview">Overview</a></li>
      <li><a href="#Forum_List_API">Forum List API</a>
        <ul class="toc">
          <li><a href="#forum_list_intro">Forum List  API Introduction</a></li>
          <li><a href="#forum_list_url">Forum List API Request URL</a></li>
          <li><a href="#forum_list_output">Forum List API Output {strtoupper($api_output)} Data</a></li>
        </ul>
      </li>
      <li><a href="#Forum_View_API">Forum View API</a>
        <ul class="toc">
          <li><a href="#forum_view_intro">Forum View API Introduction</a></li>
          <li><a href="#forum_view_url">Forum View API Request URL</a></li>
          <li><a href="#forum_view_output">Forum View API Output {strtoupper($api_output)} Data</a></li>
        </ul>
      </li>
      <li><a href="#Forum_Write_API">Forum Write API</a>
        <ul class="toc">
          <li><a href="#forum_write_intro">Forum Write API Introduction</a></li>
          <li><a href="#forum_write_url">Forum Write API Request URL</a></li>
          <li><a href="#forum_write_output">Forum Write API Output {strtoupper($api_output)} Data</a></li>
        </ul>
      </li>
      <li><a href="#Forum_Modify_API">Forum Modify API</a>
        <ul class="toc">
          <li><a href="#forum_modify_intro">Forum Modify API Introduction</a></li>
          <li><a href="#forum_modify_url">Forum Modify API Request URL</a></li>
          <li><a href="#forum_modify_output">Forum Modify API Output {strtoupper($api_output)} Data</a></li>
        </ul>
      </li>
      <li><a href="#Forum_Delete_API">Forum Delete API</a>
        <ul class="toc">
          <li><a href="#forum_delete_intro">Forum Delete API Introduction</a></li>
          <li><a href="#forum_delete_url">Forum Delete API Delelte API Request URL</a></li>
          <li><a href="#forum_delete_output">Forum Delete API Output {strtoupper($api_output)} Data</a></li>
        </ul>
      </li>
      <li><a href="#Forum_Category_API">Forum Category API</a>
        <ul class="toc">
          <li><a href="#forum_category_intro">Forum Category API Introduction</a></li>
          <li><a href="#forum_category_url">Forum Category API List Category Request URL</a></li>
          <li><a href="#forum_category_output">Forum Category API Output {strtoupper($api_output)} Data</a></li>
        </ul>
      </li>
      <li><a href="#API_Error">API Errors Collection </a></li>
    </ol>

	<!-- Overview -->
	<a name="Overview"></a>
	<h2>Overview</h2>
	<p>Forum {strtoupper($api_output)} API generated by XE API Center module allows user to retrieve or modify data from a specific XE Forum module. The data retrieved from the module is described in {strtoupper($api_output)} format, so that user can use those data in other Web or Mobile Apps.  </p>
	<p>Forum {strtoupper($api_output)} API contains five API types: List, View, Write, Modify, Delete and Category. The List, View and Category APIs are used to retrieve (read) data from the forum module, the Write, Modify and Delete APIs are used to change (write) the data to the forum module.</p>

	<!-- Forum List API -->
	<a name="Forum_List_API"></a>
	<h2>Forum List API</h2>
	<ul>
      <li><a href="#forum_list_intro">Forum List API Introduction</a></li>
      <li><a href="#forum_list_url">Forum List API Request URL</a></li>
      <li><a href="#forum_list_output">Forum List API Output {strtoupper($api_output)} Data</a></li>
    </ul>
	<!-- Forum List API Introduction-->
	<a name="forum_list_intro"></a>
	<h3>Forum List API Introduction</h3>
	<p>Forum List API allows user to access to the <b>document list</b> data from a XE forum module, since it is only used to read the data from the forum module (i.e. uses read-only query of the module data), this kind of API will be generated without login authentication by default. The output data is described in {strtoupper($api_output)} format and contains all the data refered to the document list. </p>
	<!-- Forum List API Request URL-->
	<a name="forum_list_url"></a>
	<h3>Forum List API Request URL </h3>
	<p>Below are the sample Forum List API request URLs</p>
	<label>Without Login Authentication (default):</label><pre class="prettyprint"><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1111</span><span class="pun">&amp;</span><span class="var">limit</span><span class="pun">=</span><span class="val">20</span><span class="pun">&amp;</span><span class="var">page</span><span class="pun">=</span><span class="val">1</span></pre>
	<label>With Login Authentication (call Login API first):</label><pre class="prettyprint"><span>Login API: </span><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">101</span><span class="pun">&amp;</span><span class="var">uname</span><span class="pun">=</span><span class="val">youUserName</span><span class="pun">&amp;</span><span class="var">pwd</span><span class="pun">=</span><span class="val">yourPassword</span><br><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">token</span><span class="pun">=</span><span class="val">accessToken</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1111</span><span class="pun">&amp;</span><span class="var">limit</span><span class="pun">=</span><span class="val">20</span><span class="pun">&amp;</span><span class="var">page</span><span class="pun">=</span><span class="val">1</span></pre>
	<div class="req_param">Request Parameters</div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%">URL Parameters</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>module</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>module</code> parameter specifies the module name of XE API Center module, it must be a constant value: apicenter. e.g. module=apicenter</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>api_k</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>api_key</code> parameter refers to the API access key for this API request, it is generated by the XE admininstrator on API Center module admin panel with 16-character alphanumeric value long. e.g. api_key=AB12CD34EF56</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>uid</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>uid</code> parameter specifies the url identifier of the API request, it must be contained in the API URL. e.g. uid=1111</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>token</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory if Auth is enabled</strong>. The <code>token</code> parameter refers to the access token of the API request, it is generated after the user called Login API successfully.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>limit</strong></td>
			  <td class="tagtype"><p> <strong>Optional</strong>. The <code>limit</code> parameter specifies the limit number of rows data to be retrieved, if the parameter is not specified, then all the document list data will be retrieved.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>page</strong></td>
			  <td class="tagtype"><p> <strong>Optional</strong>. The <code>page</code> parameter specifies the page number of the data to be retrieved, for example, the limit parameter is 20 and page parameter is 2, then the document list data from 21- 40 will be retrieved.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>uname</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>uname</code> parameter specifies the user name of Login API request, it must be provided when Login API is called. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>pwd</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>pwd</code>  parameter specifies the user password of Login API request, it must be provided when Login API is called.</p></td>
			</tr>
		</tbody>
	</table>

	<!-- Forum List API Output Data-->
	<a name="forum_list_output"></a>
	<h3>Forum List API Output {strtoupper($api_output)} Data</h3>
	<p>As we mentioned above, the output data for this kind of API is described in {strtoupper($api_output)} format and collect the document list data of a XE forum module, below is a sample output data:</p>
<block cond="$api_output == 'xml'">
<pre class="prettyprint" style="color: #008800;">&lt;?xml version="1.0" encoding="UTF-8"?&gt;<xmp><status_code>200</status_code>
<status_message>Load forum document list successful.</status_message>
<documents doc_count="2">
	<document>
		<id>1000</id>
		<title>The Title of Document One</title>
		<category>
			<category_id>1234</category_id>
			<category_title>Document Category Title</category_title>
		</category>
		<content><p>My document content is here</p></content>
		<create_date>20120807033154</create_date>
		<author>admin</author>
		<thumbnail>http://youxedomain/thumbnails/057/100x100.crop.jpg</thumbnail>
		<comment_count>5</comment_count>
	</document>
	<document>
		<id>1001</id>
		<title>The Second Document Title </title>
		<content><p>The google link is described as below</p><a href="http://www.google.com">Google Search</a></content>
		<create_date>20120719091805</create_date>
		<author>xe_master</author>
		<thumbnail>http://youxedomain/thumbnails/thumbnails/177/100x100.crop.jpg</thumbnail>
		<comment_count>12</comment_count>
	</document>
</documents></xmp></pre>
</block>
<block cond="$api_output == 'json'">
<pre class="prettyprint" style="color: #008800;">{
    "status_code": "200",
    "status_message": "Load forum document list successful.",
    "documents": {
        "attributes": {
            "doc_count": "2"
        },
        "document": [
            {
                "id": "1000",
                "title": "The Title of Document One",
                "category": {
                    "category_id": "1234",
                    "category_title": "Document Category Title"
                },
                "content": "&amp;lt;p&amp;gt;My document content is here&amp;lt;/p&amp;gt;",
                "create_date": "20120807033154",
                "author": "admin",
                "thumbnail": "http://youxedomain/thumbnails/057/100x100.crop.jpg",
                "comment_count": "5"
            },
            {
                "id": "1001",
                "title": "The Second Document Title",
                "content": "&amp;lt;p&amp;gt;The google link is described as below&amp;lt;/p&amp;gt;",
                "create_date": "20120719091805",
                "author": "xe_master",
                "thumbnail": "http://youxedomain/thumbnails/thumbnails/177/100x100.crop.jpg",
                "comment_count": "12"
            }
        ]
    }
}</pre>
</block>
<div class="req_param"><block cond="$api_output == 'xml'">Output XML Data Introduction</block><block cond="$api_output == 'json'">Output JSON Data Introduction</block></div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%"><block cond="$api_output == 'xml'">XML Tags</block><block cond="$api_output == 'json'">JSON Nodes</block></th>
			  <th class="attrheaderl" width="15%">Parent</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_code</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_code</code> tag represents the status identifier of the API request being called, code 200 stands for that API request is called successfully.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_message</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_message</code> tag represents the status message of the API request being called</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>documents</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p>  The <code>documents</code> tag represents the document list of the specific forum module, it  has an attribute <b>doc_count</b> which refers to the number of documents retrieved. The tag contains a number of document tag, each of which represents one document information.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>document</strong></td>
			  <td class="tagname">documents</td>
			  <td class="tagtype"><p> The <code>document</code> tag represents a document information in document list. it contains several children tags: id, title, category etc.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>id</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>id</code> tag represents the document identifier .</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>title</strong></td>
			   <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>title</code> tag represents the document title.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>category</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>category</code> tag represents the document category, it is available only if the document is categorized. The tag contains two children tags: category_id and category_title.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>category_id</strong></td>
			  <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>category_id</code> tag represents the category identifier.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>category_title</strong></td>
			  <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>category_title</code> tag represents the title of category.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>content</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>content</code> tag represents the content of document, whcih is html source code. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>create_date</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>create_date</code> tag represents the created date of the document.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>author</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>author</code> tag represents the document author name.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>thumbnail</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>thumbnail</code> tag represents the thumbnail link of the document, it is only available if the document has thumbnail. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>comment_count</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>comment_count</code> tag represents the number of comments that the document has.</p></td>
			</tr>
		</tbody>
	</table>


	<!-- Forum View API -->
	<a name="Forum_View_API"></a>
	<h2>Forum View API</h2>
	<ul>
      <li><a href="#forum_view_intro">Forum View API Introduction</a></li>
      <li><a href="#forum_view_url">Forum View API Request URL</a></li>
      <li><a href="#forum_view_output">Forum View API Output {strtoupper($api_output)} Data</a></li>
    </ul>
	<!-- Forum View API Introduction-->
	<a name="forum_view_intro"></a>
	<h3>Forum View API Introduction</h3>
	<p>Forum View API allows user to access to one specific <b>document</b> information data from a XE forum module, it is only used to read the data from the forum module (i.e. uses read-only query of the module data), this kind of API will be generated without login authentication by default. The output data is described in {strtoupper($api_output)} format and contains all the data refered to the document. </p>

	<!-- Forum View API Request URL-->
	<a name="forum_view_url"></a>
	<h3>Forum View API Request URL </h3>
	<p>Below are the sample Forum View API request URLs</p>
	<label>Without Login Authentication (default):</label><pre class="prettyprint"><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1112</span><span class="pun">&amp;</span><span class="var">doc_id</span><span class="pun">=</span><span class="val">documentID</span></pre>
	<label>With Login Authentication (call Login API first):</label><pre class="prettyprint"><span>Login API: </span><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">102</span><span class="pun">&amp;</span><span class="var">uname</span><span class="pun">=</span><span class="val">youUserName</span><span class="pun">&amp;</span><span class="var">pwd</span><span class="pun">=</span><span class="val">yourPassword</span><br><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">token</span><span class="pun">=</span><span class="val">accessToken</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1112</span><span class="pun">&amp;</span><span class="var">doc_id</span><span class="pun">=</span><span class="val">documentID</span></pre>
	<div class="req_param">Request Parameters</div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%">URL Parameters</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>module</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>module</code> parameter specifies the module name of XE API Center module, it must be a constant value: apicenter. e.g. module=apicenter</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>api_k</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>api_key</code> parameter refers to the API access key for this API request, it is generated by the XE admininstrator on API Center module admin panel with 16-character alphanumeric value long. e.g. api_key=AB12CD34EF56</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>uid</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>uid</code> parameter specifies the url identifier of the API request, it must be contained in the API URL. e.g. uid=1112</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>doc_id</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>doc_id</code> parameter specifies the identifier of the document to be withdrawn, it must be provided in View, Modify and Delete APIs. e.g. doc_id=1025 </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>token</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory if Auth is enabled</strong>. The <code>token</code> parameter refers to the access token of the API request, it is generated after the user called Login API successfully.</p></td>
			</tr>
			  <td class="tagname"><strong>uname</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>uname</code> parameter specifies the user name of Login API request, it must be provided when Login API is called. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>pwd</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>pwd</code>  parameter specifies the user password of Login API request, it must be provided when Login API is called.</p></td>
			</tr>
		</tbody>
	</table>

	<!-- Forum View API Output  Data-->
	<a name="forum_view_output"></a>
	<h3>Forum View API Output {strtoupper($api_output)} Data</h3>
	<p>As we mentioned above, the output data for this kind of API is described in {strtoupper($api_output)} format and collect the document info data of a XE forum module, below is a sample output data:</p>
<block cond="$api_output == 'xml'">
<pre class="prettyprint" style="color: #008800;">&lt;?xml version="1.0" encoding="UTF-8"?&gt;<xmp><status_code>200</status_code>
<status_message>Load forum document information successful.</status_message>
<document>
	<id>1002</id>
	<title>The Title of Document One</title>
	<category>
		<category_id>1234</category_id>
		<category_title>Document Category Title</category_title>
	</category>
	<content><p>My document content is here</p></content>
	<create_date>20120807033154</create_date>
	<author>admin</author>
	<readed_count>0</readed_count>
	<voted_count>0</voted_count>
	<thumbnail>http://youxedomain/thumbnails/057/100x100.crop.jpg</thumbnail>
	<attachments attach_count="2">
		<attachment>
			<filename>img_3.jpg</filename>
			<filesize>137725</filesize>
			<download>http://youxedomain/?module=file&act=procFileDownload&file_srl=1058&sid=a080c9954cc8d</download>
		</attachment>
		<attachment>
			<filename>1.jpg</filename>
			<filesize>6654</filesize>
			<download>http:/youxedomain/?module=file&act=procFileDownload&file_srl=1153&sid=ffd36d5d64f35d</download>
		</attachment>
	</attachments>
	<comment_count>2</comment_count>
	<comments>
		<comment>
			<comment_id>1147</comment_id>
			<comment_content><p>First comment contents</p></comment_content>
			<comment_date>20120810081243</comment_date>
			<comment_author>xe_master</comment_author>
		</comment>
		<comment>
			<comment_id>1150</comment_id>
			<comment_content><p>Second comments contents</p></comment_content>
			<comment_date>20120810081254</comment_date>
			<comment_author>xe_tester</comment_author>
		</comment>
	</comments>
</document></xmp></pre>
</block>
<block cond="$api_output == 'json'">
<pre class="prettyprint" style="color: #008800;">{
    "status_code": "200",
    "status_message": "Load forum document information successful.",
    "document": {
        "id": "1002",
        "title": "The Title of Document One",
        "category": {
            "category_id": "1234",
            "category_title": "Document Category Title"
        },
        "content": "&amp;lt;p&amp;gt;My document content is here&amp;lt;/p&amp;gt;",
        "create_date": "20120807033154",
        "author": "admin",
        "readed_count": "0",
        "voted_count": "0",
        "thumbnail": "http://youxedomain/thumbnails/057/100x100.crop.jpg",
        "attachments": {
            "attributes": {
                "attach_count": "2"
            },
            "attachment": [
                {
                    "filename": "img_3.jpg",
                    "filesize": "137725",
                    "download": "http://youxedomain/?module=file&act=procFileDownload&file_srl=1058&sid=a080c9954cc8d"
                },
                {
                    "filename": "1.jpg",
                    "filesize": "6654",
                    "download": "http:/youxedomain/?module=file&act=procFileDownload&file_srl=1153&sid=ffd36d5d64f35d"
                }
            ]
        },
        "comment_count": "2",
        "comments": {
            "comment": [
                {
                    "comment_id": "1147",
                    "comment_content": "&amp;lt;p&amp;gt;Second comments contents&amp;lt;/p&amp;gt;",
                    "comment_date": "20120810081243",
                    "comment_author": "xe_master"
                },
                {
                    "comment_id": "1150",
                    "comment_content": "&amp;lt;p&gt;here is my another comment&amp;lt;/p&amp;gt;",
                    "comment_date": "20120810081254",
                    "comment_author": "xe_tester"
                }
            ]
        }
    }
}</pre>
</block>
	<div class="req_param"><block cond="$api_output == 'xml'">Output XML Data Introduction</block><block cond="$api_output == 'json'">Output JSON Data Introduction</block></div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%"><block cond="$api_output == 'xml'">XML Tags</block><block cond="$api_output == 'json'">JSON Nodes</block></th>
			  <th class="attrheaderl" width="15%">Parent</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_code</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_code</code> tag represents the status identifier of the API request being called, code 200 stands for that API request is called successfully.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_message</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_message</code> tag represents the status message of the API request being called</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>document</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>document</code> tag contains the whole document information. it contains several children tags: id, title, category, content, author etc.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>id</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>id</code> tag represents the document identifier .</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>title</strong></td>
			   <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>title</code> tag represents the document title.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>category</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>category</code> tag represents the document category, it is available only if the document is categorized. The tag contains two children tags: category_id and category_title.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>category_id</strong></td>
			  <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>category_id</code> tag represents the category identifier.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>category_title</strong></td>
			  <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>category_title</code> tag represents the title of category.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>content</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>content</code> tag represents the content of document, whcih is html source code. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>create_date</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>create_date</code> tag represents the created date of the document.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>author</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>author</code> tag represents the document author name.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>readed_count</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>readed_count</code> tag represents the read number of the original document in the forum module.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>voted_count</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>voted_count</code> tag represents the vote number of the original document in the forum module.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>thumbnail</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>thumbnail</code> tag represents the thumbnail link of the document, it is only available if the document has thumbnail. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>attachments</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>attachments</code> tag is represented if the document has uploaded attachments. It has an attribute <b>attach_count</b> to display the number of attachment that the document has.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>attachment</strong></td>
			  <td class="tagname">attachments</td>
			  <td class="tagtype"><p> The <code>attachment</code> tag represents one attachment information. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>filename</strong></td>
			  <td class="tagname">attachment</td>
			  <td class="tagtype"><p> The <code>filename</code> tag represents the file name of the attachment. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>filesize</strong></td>
			  <td class="tagname">attachment</td>
			  <td class="tagtype"><p> The <code>filesize</code> tag represents the size of attachment file. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>download</strong></td>
			  <td class="tagname">attachment</td>
			  <td class="tagtype"><p> The <code>download</code> tag represents the download link of the attachment file. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>comment_count</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>comment_count</code> tag represents the number of comments that the document has.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>comments</strong></td>
			  <td class="tagname">document</td>
			  <td class="tagtype"><p> The <code>comments</code> tag is represented if the document has comments.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>comment</strong></td>
			  <td class="tagname">comments</td>
			  <td class="tagtype"><p> The <code>comment</code> tag represents the one comment information.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>comment_id</strong></td>
			  <td class="tagname">comment</td>
			  <td class="tagtype"><p> The <code>comment_id</code> tag represents the identifer of the comment.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>comment_content</strong></td>
			  <td class="tagname">comment</td>
			  <td class="tagtype"><p> The <code>comment_content</code> tag represents the comment content, it is described in html source code.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>comment_date</strong></td>
			  <td class="tagname">comment</td>
			  <td class="tagtype"><p> The <code>comment_date</code> tag represents the created data of the comment.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>comment_author</strong></td>
			  <td class="tagname">comment</td>
			  <td class="tagtype"><p> The <code>comment_author</code> tag represents the author name of the comment.</p></td>
			</tr>
		</tbody>
	</table>

	<!-- Forum Write API -->
	<a name="Forum_Write_API"></a>
	<h2>Forum Write API</h2>
	<ul>
      <li><a href="#forum_write_intro">Forum Write API Introduction</a></li>
      <li><a href="#forum_write_url">Forum Write API Request URL</a></li>
      <li><a href="#forum_write_output">Forum Write API Output {strtoupper($api_output)} Data</a></li>
    </ul>

	<!-- Forum Write API Introduction-->
	<a name="forum_write_intro"></a>
	<h3>Forum Write API Introduction</h3>
	<p>Forum Write API allows user to add a new document to a spcific XE forum module, since it is used to write the data to forum module (i.e. uses write query of the module data), this kind of API will be generated with login authentication by default. The most important, Forum Write API Request can only be called by <label class="post">POST</label> HTTP method.</p>

	<!-- Forum Write API Request URL-->
	<a name="forum_write_url"></a>
	<h3>Forum Write API Request URL </h3>
	<p>Below are the sample Forum Write API request URLs</p>
	<label>With Login Authentication (default, call Login API first):</label><pre class="prettyprint"><span>Login API: </span><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">103</span><span class="pun">&amp;</span><span class="var">uname</span><span class="pun">=</span><span class="val">youUserName</span><span class="pun">&amp;</span><span class="var">pwd</span><span class="pun">=</span><span class="val">yourPassword</span><br><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">token</span><span class="pun">=</span><span class="val">accessToken</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1113</span><span class="pun">&amp;</span><span class="var">title</span><span class="pun">=</span><span class="val">docTitle</span><span class="pun">&amp;</span><span class="var">content</span><span class="pun">=</span><span class="val">docContent</span><span class="pun">&amp;</span><span class="var">cat_id</span><span class="pun">=</span><span class="val">categoryID</span>&nbsp;&nbsp;&nbsp;<label class="post">POST Request Only</label></pre>
	<label>Without Login Authentication:</label><pre class="prettyprint"><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1113</span><span class="pun">&amp;</span><span class="var">title</span><span class="pun">=</span><span class="val">docTitle</span><span class="pun">&amp;</span><span class="var">content</span><span class="pun">=</span><span class="val">docContent</span><span class="pun">&amp;</span><span class="var">cat_id</span><span class="pun">=</span><span class="val">categoryID</span>&nbsp;&nbsp;&nbsp;<label class="post">POST Request Only</label></pre>
	<div class="req_param">Request Parameters</div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%">URL Parameters</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>module</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>module</code> parameter specifies the module name of XE API Center module, it must be a constant value: apicenter. e.g. module=apicenter</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>api_k</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>api_key</code> parameter refers to the API access key for this API request, it is generated by the XE admininstrator on API Center module admin panel with 16-character alphanumeric value long. e.g. api_key=AB12CD34EF56</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>uid</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>uid</code> parameter specifies the url identifier of the API request, it must be contained in the API URL. e.g. uid=1113</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>title</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>title</code> parameter specifies the title of document to be added. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>content</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>content</code> parameter specifies the content of document to be added. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>cat_id</strong></td>
			  <td class="tagtype"><p> <strong>Optional</strong>. The <code>cat_id</code> parameter specifies the document category id, this category id can be obtained by requesting Forum Category API. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>token</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory if Auth is enabled</strong>. The <code>token</code> parameter refers to the access token of the API request, it is generated after the user called Login API successfully.</p></td>
			</tr>
			  <td class="tagname"><strong>uname</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>uname</code> parameter specifies the user name of Login API request, it must be provided when Login API is called. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>pwd</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>pwd</code>  parameter specifies the user password of Login API request, it must be provided when Login API is called.</p></td>
			</tr>
		</tbody>
	</table>

	<!-- Forum Write API Output  Data-->
	<a name="forum_write_output"></a>
	<h3>Forum Write API Output {strtoupper($api_output)} Data</h3>
	<p>The output data of Forum Write API indicates if the document has been added to the module successfully, below is a sample output data:</p>
<block cond="$api_output == 'xml'">
<pre class="prettyprint" style="color: #008800;">&lt;?xml version="1.0" encoding="UTF-8"?&gt;<xmp><status_code>200</status_code>
<status_message>The forum document has been added successfully.</status_message>
<document_id>1345</document_id></xmp></pre>
</block>
<block cond="$api_output == 'json'">
<pre class="prettyprint" style="color: #008800;">{
    "status_code": "200",
    "status_message": "The forum document has been added successfully.",
    "document_id": "1345"
}</pre>
</block>
	<div class="req_param"><block cond="$api_output == 'xml'">Output XML Data Introduction</block><block cond="$api_output == 'json'">Output JSON Data Introduction</block></div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%"><block cond="$api_output == 'xml'">XML Tags</block><block cond="$api_output == 'json'">JSON Node</block></th>
			  <th class="attrheaderl" width="15%">Parent</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_code</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_code</code> tag represents the status identifier of the API request being called, code 200 stands for that API request is called successfully.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_message</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_message</code> tag represents the status message of the API request being called</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>document_id</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p>  The <code>document_id</code> tag represents the identifier of document which has been added successfully.</p></td>
			</tr>
		</tbody>
	</table>

	<!-- Forum Modify API -->
	<a name="Forum_Modify_API"></a>
	<h2>Forum Modify API</h2>
	<ul>
      <li><a href="#forum_modify_intro">Forum Modify API Introduction</a></li>
      <li><a href="#forum_modify_url">Forum Modify API Request URL</a></li>
      <li><a href="#forum_modify_output">Forum Modify API Output {strtoupper($api_output)} Data</a></li>
    </ul>

	<!-- Forum Modify API Introduction-->
	<a name="forum_modify_intro"></a>
	<h3>Forum Modify API Introduction</h3>
	<p>Forum Modify API allows user to modify the document title and content of a spcific XE forum module, since it is used to change the data to forum module (i.e. uses write query of the module data), this kind of API will be generated with login authentication by default. The most important, Forum Modify API Request can only be called by <label class="post">POST</label> HTTP method.</p>

	<!-- Forum Modify API Request URL-->
	<a name="forum_modify_url"></a>
	<h3>Forum Modify API Request URL </h3>
	<p>Below are the sample Forum Modify API request URLs</p>
	<label>With Login Authentication (default, call Login API first):</label><pre class="prettyprint"><span>Login API: </span><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">104</span><span class="pun">&amp;</span><span class="var">uname</span><span class="pun">=</span><span class="val">youUserName</span><span class="pun">&amp;</span><span class="var">pwd</span><span class="pun">=</span><span class="val">yourPassword</span><br><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">token</span><span class="pun">=</span><span class="val">accessToken</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1114</span><span class="pun">&amp;</span><span class="var">doc_id</span><span class="pun">=</span><span class="val">1026</span><span class="pun">&amp;</span><span class="var">title</span><span class="pun">=</span><span class="val">docTitle</span><span class="pun">&amp;</span><span class="var">content</span><span class="pun">=</span><span class="val">docContent</span><span class="pun">&amp;</span><span class="var">cat_id</span><span class="pun">=</span><span class="val">categoryID</span>&nbsp;&nbsp;&nbsp;<label class="post">POST Request Only</label></pre>
	<label>Without Login Authentication:</label><pre class="prettyprint"><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1114</span><span class="pun">&amp;</span><span class="var">doc_id</span><span class="pun">=</span><span class="val">1026</span><span class="pun">&amp;</span><span class="var">title</span><span class="pun">=</span><span class="val">docTitle</span><span class="pun">&amp;</span><span class="var">content</span><span class="pun">=</span><span class="val">docContent</span><span class="pun">&amp;</span><span class="var">cat_id</span><span class="pun">=</span><span class="val">categoryID</span>&nbsp;&nbsp;&nbsp;<label class="post">POST Request Only</label></pre>
	<div class="req_param">Request Parameters</div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%">URL Parameters</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>module</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>module</code> parameter specifies the module name of XE API Center module, it must be a constant value: apicenter. e.g. module=apicenter</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>api_k</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>api_key</code> parameter refers to the API access key for this API request, it is generated by the XE admininstrator on API Center module admin panel with 16-character alphanumeric value long. e.g. api_key=AB12CD34EF56</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>uid</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>uid</code> parameter specifies the url identifier of the API request, it must be contained in the API URL. e.g. uid=1114</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>doc_id</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>doc_id</code> parameter specifies the document identifier, it must be provided in this kind of API.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>title</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>title</code> parameter specifies the title of document to be modified. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>content</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>content</code> parameter specifies the content of document to be modified. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>cat_id</strong></td>
			  <td class="tagtype"><p> <strong>Optional</strong>. The <code>cat_id</code> parameter specifies the document category id, this category id can be obtained by requesting Forum Category API. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>token</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory if Auth is enabled</strong>. The <code>token</code> parameter refers to the access token of the API request, it is generated after the user called Login API successfully.</p></td>
			</tr>
			  <td class="tagname"><strong>uname</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>uname</code> parameter specifies the user name of Login API request, it must be provided when Login API is called. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>pwd</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>pwd</code>  parameter specifies the user password of Login API request, it must be provided when Login API is called.</p></td>
			</tr>
		</tbody>
	</table>

	<!-- Forum Modify API Output Data-->
	<a name="forum_modify_output"></a>
	<h3>Forum Modify API Output {strtoupper($api_output)} Data</h3>
	<p>The output data of Modify API indicates if the document has been modified successfully, below is a sample output data:</p>
<block cond="$api_output == 'xml'">
<pre class="prettyprint" style="color: #008800;">&lt;?xml version="1.0" encoding="UTF-8"?&gt;<xmp><status_code>200</status_code>
<status_message>The forum document has been modified successfully.</status_message>
<document_id>1345</document_id></xmp></pre>
</block>
<block cond="$api_output == 'json'">
<pre class="prettyprint" style="color: #008800;">{
    "status_code": "200",
    "status_message": "The forum document has been modified successfully.",
    "document_id": "1345"
}</pre>
</block>
	<div class="req_param"><block cond="$api_output == 'xml'">Output XML Data Introduction</block><block cond="$api_output == 'json'">Output JSON Data Introduction</block></div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%"><block cond="$api_output == 'xml'">XML Tags</block><block cond="$api_output == 'json'">JSON Nodes</block></th>
			  <th class="attrheaderl" width="15%">Parent</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_code</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_code</code> tag represents the status identifier of the API request being called, code 200 stands for that API request is called successfully.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_message</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_message</code> tag represents the status message of the API request being called</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>document_id</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p>  The <code>document_id</code> tag represents the identifier of document which has been modified successfully.</p></td>
			</tr>
		</tbody>
	</table>

	<!-- Forum Delete API -->
	<a name="Forum_Delete_API"></a>
	<h2>Forum Delete API</h2>
	<ul>
      <li><a href="#forum_delete_intro">Forum Delete API Introduction</a></li>
      <li><a href="#forum_delete_url">Forum Delete API Request URL</a></li>
      <li><a href="#forum_delete_output">Forum Delete API Output {strtoupper($api_output)} Data</a></li>
    </ul>

	<!-- Forum Delete API Introduction-->
	<a name="forum_delete_intro"></a>
	<h3>Forum Delete API Introduction</h3>
	<p>Forum Delete API allows user to delete a document from a spcific XE forum module, since it is used to change the data to forum module (i.e. uses write query of the module data), this kind of API will be generated with login authentication by default. The most important, Forum Delete API Request can only be called by <label class="post">POST</label> HTTP method.</p>

	<!-- Forum Delete API Request URL-->
	<a name="forum_delete_url"></a>
	<h3>Forum Delete API Request URL </h3>
	<p>Below are the sample Forum Delete API request URLs</p>
	<label>With Login Authentication (default, call Login API first):</label><pre class="prettyprint"><span>Login API: </span><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">105</span><span class="pun">&amp;</span><span class="var">uname</span><span class="pun">=</span><span class="val">youUserName</span><span class="pun">&amp;</span><span class="var">pwd</span><span class="pun">=</span><span class="val">yourPassword</span><br><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">token</span><span class="pun">=</span><span class="val">accessToken</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1115</span><span class="pun">&amp;</span><span class="var">doc_id</span><span class="pun">=</span><span class="val">1027</span>&nbsp;&nbsp;&nbsp;<label class="post">POST Request Only</label></pre>
	<label>Without Login Authentication:</label><pre class="prettyprint"><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1115</span><span class="pun">&amp;</span><span class="var">doc_id</span><span class="pun">=</span><span class="val">1027</span>&nbsp;&nbsp;&nbsp;<label class="post">POST Request Only</label></pre>
	<div class="req_param">Request Parameters</div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%">URL Parameters</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>module</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>module</code> parameter specifies the module name of XE API Center module, it must be a constant value: apicenter. e.g. module=apicenter</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>api_k</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>api_key</code> parameter refers to the API access key for this API request, it is generated by the XE admininstrator on API Center module admin panel with 16-character alphanumeric value long. e.g. api_key=AB12CD34EF56</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>uid</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>uid</code> parameter specifies the url identifier of the API request, it must be contained in the API URL. e.g. uid=1115</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>doc_id</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>doc_id</code> parameter specifies the document identifier, it must be provided in this kind of API.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>token</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory if Auth is enabled</strong>. The <code>token</code> parameter refers to the access token of the API request, it is generated after the user called Login API successfully.</p></td>
			</tr>
			  <td class="tagname"><strong>uname</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>uname</code> parameter specifies the user name of Login API request, it must be provided when Login API is called. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>pwd</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>pwd</code>  parameter specifies the user password of Login API request, it must be provided when Login API is called.</p></td>
			</tr>
		</tbody>
	</table>

	<!-- Forum Delete API Output Data-->
	<a name="forum_delete_output"></a>
	<h3>Forum Delete API Output {strtoupper($api_output)} Data</h3>
	<p>The output data of Delete  API indicates if the document has been deleted successfully, below is a sample output data:</p>
<block cond="$api_output == 'xml'">
<pre class="prettyprint" style="color: #008800;">&lt;?xml version="1.0" encoding="UTF-8"?&gt;<xmp><status_code>200</status_code>
<status_message>The forum document has been deleted successfully.</status_message></xmp></pre>
</block>
<block cond="$api_output == 'json'">
<pre class="prettyprint" style="color: #008800;">{
    "status_code": "200",
    "status_message": "The forum document has been deleted successfully."
}</pre>
</block>
	<div class="req_param"><block cond="$api_output == 'xml'">Output XML Data Introduction</block><block cond="$api_output == 'json'">Output JSON Data Introduction</block></div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%"><block cond="$api_output == 'xml'">XML Tags</block><block cond="$api_output == 'json'">JSON Nodes</block></th>
			  <th class="attrheaderl" width="15%">Parent</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_code</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_code</code> tag represents the status identifier of the API request being called, code 200 stands for that API request is called successfully.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_message</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_message</code> tag represents the status message of the API request being called</p></td>
			</tr>
		</tbody>
	</table>

	<!-- Forum Category API -->
	<a name="Forum_Category_API"></a>
	<h2>Forum Category API</h2>
	<ul>
      <li><a href="#forum_category_intro">Forum Category API Introduction</a></li>
      <li><a href="#forum_category_url">Forum Category API Request URL</a></li>
      <li><a href="#forum_category_output">Forum Category API Output {strtoupper($api_output)} Data</a></li>
    </ul>

	<!-- Forum Category API Introduction-->
	<a name="forum_category_intro"></a>
	<h3>Forum Category API Introduction</h3>
	<p>Forum Category API allows user to retrieve document categories information from a XE forum module, it is only available if the category function is enabled in the forum module. Since the API only used to read the data from the forum module (i.e. uses read-only query of the module data), this kind of API will be generated without login authentication by default.</p>

	<!-- Forum Category API Request URL-->
	<a name="forum_category_url"></a>
	<h3>Forum Category API Request URL </h3>
	<p>Below are the sample Forum Category API request URLs</p>
	<label>Without Login Authentication (default):</label><pre class="prettyprint"><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1116</span><span class="pun">&amp;</span><span class="var">target</span><span class="pun">=</span><span class="val">category</span></pre>
	<label>With Login Authentication (call Login API first):</label><pre class="prettyprint"><span>Login API: </span><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">102</span><span class="pun">&amp;</span><span class="var">uname</span><span class="pun">=</span><span class="val">youUserName</span><span class="pun">&amp;</span><span class="var">pwd</span><span class="pun">=</span><span class="val">yourPassword</span><br><span class="domain">http://yourxedomain/index.php?</span><span class="var">module</span><span class="pun">=</span><span class="val">apicenter</span><span class="pun">&amp;</span><span class="var">api_k</span><span class="pun">=</span><span class="val">APIKey</span><span class="pun">&amp;</span><span class="var">token</span><span class="pun">=</span><span class="val">accessToken</span><span class="pun">&amp;</span><span class="var">uid</span><span class="pun">=</span><span class="val">1116</span><span class="pun">&amp;</span><span class="var">target</span><span class="pun">=</span><span class="val">category</span></pre>
	<div class="req_param">Request Parameters</div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%">URL Parameters</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>module</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>module</code> parameter specifies the module name of XE API Center module, it must be a constant value: apicenter. e.g. module=apicenter</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>api_k</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>api_key</code> parameter refers to the API access key for this API request, it is generated by the XE admininstrator on API Center module admin panel with 16-character alphanumeric value long. e.g. api_key=AB12CD34EF56</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>uid</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>uid</code> parameter specifies the url identifier of the API request, it must be contained in the API URL. e.g. uid=1116</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>target</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory</strong>. The <code>target</code> parameter must be a constant value: category, which represents the the target data of API is document category. e.g. target=category </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>token</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory if Auth is enabled</strong>. The <code>token</code> parameter refers to the access token of the API request, it is generated after the user called Login API successfully.</p></td>
			</tr>
			  <td class="tagname"><strong>uname</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>uname</code> parameter specifies the user name of Login API request, it must be provided when Login API is called. </p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>pwd</strong></td>
			  <td class="tagtype"><p> <strong>Mandatory for Login API</strong>. The <code>pwd</code>  parameter specifies the user password of Login API request, it must be provided when Login API is called.</p></td>
			</tr>
		</tbody>
	</table>

	<!-- Forum Category API Output Data-->
	<a name="forum_category_output"></a>
	<h3>Forum Category API Output {strtoupper($api_output)} Data</h3>
	<p>As we mentioned above, the output data for this kind of API is described in {strtoupper($api_output)} format and collect the document categories data of a XE forum module, below is a sample output data:</p>
<block cond="$api_output == 'xml'">
<pre class="prettyprint" style="color: #008800;">&lt;?xml version="1.0" encoding="UTF-8"?&gt;<xmp><status_code>200</status_code>
<status_message>Load forum category list successful.</status_message>
<categories cat_count="2">
	<category>
		<id>1548</id>
		<title>Category One Title</title>
		<description>All the document belongs to Category One is collected here</description>
		<child_count>1</child_count>
		<children>1549</children>
		<depth>0</depth>
	</category>
	<category>
		<id>1549</id>
		<parent_category>1548</parent_category>
		<title>Category Two Title </title>
		<description>All the document belongs to Category Two is collected here</description>
		<child_count>0</child_count>
		<depth>1</depth>
	</category>
</categories></xmp></pre>
</block>
<block cond="$api_output == 'json'">
<pre class="prettyprint" style="color: #008800;">{
    "status_code": "200",
    "status_message": "Load forum category list successful.",
    "categories": {
        "attributes": {
            "cat_count": "2"
        },
        "category": [
            {
                "id": "1548",
                "title": "Category One Title",
				"description":"All the document belongs to Category One is collected here",
                "child_count": "1",
				"children":"1549",
                "depth": "0"
            },
            {
                "id": "1549",
                "title": "category2",
				"parent_category":"1548",
				"title":"Category Two Title",
				"description":"All the document belongs to Category Two is collected here",
                "child_count": "0",
                "depth": "1"
            }
        ]
    }
}</pre>
</block>
	<div class="req_param"><block cond="$api_output == 'xml'">Output XML Data Introduction</block><block cond="$api_output == 'json'">Output JSON Data Introduction</block></div>
	<table width="100%" border="1">
		  <tbody>
			<tr>
			  <th class="attrheaderl" width="15%"><block cond="$api_output == 'xml'">XML Tags</block><block cond="$api_output == 'json'">JSON Nodes</block></th>
			  <th class="attrheaderl" width="15%">Parent</th>
			  <th class="attrheaderl">Description</th>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_code</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_code</code> tag represents the status identifier of the API request being called, code 200 stands for that API request is called successfully.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>status_message</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p> The <code>status_message</code> tag represents the status message of the API request being called</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>categories</strong></td>
			  <td class="tagname">root</td>
			  <td class="tagtype"><p>  The <code>categories</code> tag represents the category list of the specific forum module, it  has an attribute <b>cat_count</b> which refers to the number of categories retrieved.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>category</strong></td>
			  <td class="tagname">categories</td>
			  <td class="tagtype"><p> The <code>category</code> tag represents a category information in category list. it contains several children tags: id, title, children etc.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>id</strong></td>
			  <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>id</code> tag represents the category identifier .</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>parent_category</strong></td>
			   <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>parent_category</code> tag is represented only if the category has a parent category.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>title</strong></td>
			   <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>title</code> tag represents the category title.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>description</strong></td>
			  <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>description</code> tag represents the category description, it is only available if the category has description</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>child_count</strong></td>
			  <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>child_count</code> tag represents the number of children categories that category has.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>children</strong></td>
			  <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>children</code> tag represents the children category identifiers of the category, the children category id can be separated by comma.</p></td>
			</tr>
			<tr>
			  <td class="tagname"><strong>depth</strong></td>
			  <td class="tagname">category</td>
			  <td class="tagtype"><p> The <code>depth</code> tag represents the category hierarchical level, 0 means the root level. </p></td>
			</tr>
		</tbody>
	</table>

<include target="_api_error.html" />